#region (c) 2014 THN Solutions LLC. - All rights reserved
/*
THN DATA ABSTRACTION LAYER version 1

Copyright (c) 2014, THN Solutions LLC. ( www.ThnSolutions.com )
Author: Nguyễn, M. Hải                 ( www.Minh-Hai.com     )
All rights reserved.

This library is dual-licensed.
  + For commercial software, please obtain a commercial license from THN Solutions LLC.

  + For free software, this library is licensed under GPL version 3. A summary of GPLv3 is
    listed below. You should also find a copy of GPLv3 as file License_GPLv3.txt included
	with the source-code files.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 3 as published by
    the Free Software Foundation  of the License.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#endregion

#region Using directives
using System;
#endregion

namespace Thn.Data.Persistence
{
    /// <summary>
    /// A persistent object is a data object that can be handled by persistent layer
    /// </summary>
    public interface IPersistentObject
    {
        /// <summary>
        /// Retrieves the identifier of this object
        /// </summary>
        object GetIdentifier();

        /// <summary>
        /// Gets whether this object has been persisted to database
        /// </summary>
        bool Persistent
        { get;}

        /// <summary>
        /// Gets whether this object has been changed
        /// </summary>
        bool Modified
        { get;}

        /// <summary>
        /// Gets/Sets the persistent context this object belongs to.
        /// <para>At any time, a persistent object is tracked by one context only.</para>
        /// <para>If context is null, this object is detached from any persistence layer</para>
        /// </summary>
        IPersistentContext Context
        { get;set;}

        ///// <summary>
        ///// Save a snapshot of this object's values
        ///// </summary>
        //object SaveState();

        ///// <summary>
        ///// Load values for this object from a state bag
        ///// </summary>
        //void LoadState(object state);        
    }
}
